Skip to content

Conversation

@15g-lucas
Copy link
Member

@15g-lucas 15g-lucas commented Apr 24, 2025

It was impossible to call the should function from controlledPolicy. I changed this by calling applies

Summary by CodeRabbit

  • Refactor
    • Updated internal logic in policy methods to improve consistency in permission checks. No changes to user-facing behavior.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 24, 2025

Walkthrough

The changes update the ControlledPolicy class by replacing all calls to the should method on the Control instance with calls to the applies method. This modification affects all primary policy methods, including viewAny, view, create, update, delete, restore, and forceDelete. No changes were made to method signatures, parameters, or overall logic flow; only the internal method invoked on the Control object was altered.

Changes

File(s) Change Summary
src/Policies/ControlledPolicy.php Replaced all internal calls from should to applies on the Control instance in policy methods.

Poem

A hop and a skip, a method anew,
"Should" now rests, while "applies" comes through.
The policies checked, permissions in line,
Control’s new whisper: “You may, by design!”
With every small change, the code hops ahead—
A bunny’s approval for what lies ahead! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/Policies/ControlledPolicy.php (1)

10-10: Consider addressing the TODO comment.

There's an existing TODO comment about handling additional methods like attach/restore/force_delete, but the code already implements restore and forceDelete methods. Consider updating or removing this comment to reflect the current implementation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd5890b and 470093f.

📒 Files selected for processing (1)
  • src/Policies/ControlledPolicy.php (7 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/Policies/ControlledPolicy.php (1)
src/Controls/Control.php (1)
  • applies (49-68)
🔇 Additional comments (3)
src/Policies/ControlledPolicy.php (3)

48-48: Appropriate method replacement.

Replacing should with applies is the correct approach. Looking at the applies method from the Control class, it handles the permission check more comprehensively by iterating through perimeters and properly handling model existence.


61-61: Consistent implementation across policy methods.

All policy methods have been consistently updated to use the applies method with the same parameter structure. This ensures uniform behavior across all access control operations.

Also applies to: 86-86, 99-99, 112-112, 125-125


73-73: Correct handling for creation permissions.

The create method appropriately uses applies with a new model instance, which allows the permission system to check if the user can create models of this type without requiring an existing instance.

@GautierDele GautierDele mentioned this pull request Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant